package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpSocPlanItemAddDTO;
import org.jsola.hr.dto.EmpSocPlanItemUpdateDTO;
import org.jsola.hr.query.EmpSocPlanItemQuery;
import org.jsola.hr.vo.EmpSocPlanItemListVO;
import org.jsola.hr.vo.EmpSocPlanItemVO;

import java.util.List;

/**
 * 增减员计划子项表
 *
 * @author zhr
 */
@Api(tags = "hr-增减员计划子项表")
public interface IEmpSocPlanItemControllerAPI {

    /**
     * 新增增减员计划子项表
     * @param empSocPlanItemAddDTO 增减员计划子项表新增实体
     * @return 增减员计划子项表展示对象
     */
    @ApiOperation(value = "新增增减员计划子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemAddDTO", dataType = "EmpSocPlanItemAddDTO", value = "新增增减员计划子项表", paramType = "body")
    })
    Result<EmpSocPlanItemVO> save(EmpSocPlanItemAddDTO empSocPlanItemAddDTO);


    /**
     * 修改增减员计划子项表
     * @param empSocPlanItemUpdateDTO 增减员计划子项表
     * @return 更新数量
     */
    @ApiOperation(value = "修改增减员计划子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemUpdateDTO", dataType = "EmpSocPlanItemUpdateDTO", value = "修改增减员计划子项表", paramType = "body")
    })
    Result<Integer> update(EmpSocPlanItemUpdateDTO empSocPlanItemUpdateDTO);




    /**
     * 删除单个增减员计划子项表，彻底删除
     * @param empSocPlanItemId 增减员计划子项表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个增减员计划子项表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemId", dataType = "String", value = "增减员计划子项表id", paramType = "path")
    })
    Result<Integer> delete(String empSocPlanItemId);


    /**
     * 批量删除增减员计划子项表，彻底删除
     * @param empSocPlanItemIds 增减员计划子项表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除增减员计划子项表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemIds", dataType = "String[]", value = "增减员计划子项表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empSocPlanItemIds);


    /**
     * 根据增减员计划子项表id查询增减员计划子项表详情
     * @param empSocPlanItemId 增减员计划子项表id
     * @return 增减员计划子项表详情
     */
    @ApiOperation(value="根据增减员计划子项表id查询增减员计划子项表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemId", dataType = "String", value = "增减员计划子项表id", paramType = "path")
    })
    Result<EmpSocPlanItemVO> findById(String empSocPlanItemId);


    /**
     * 查询增减员计划子项表
     * @param empSocPlanItemQuery 增减员计划子项表查询参数
     * @return page
     */
    @ApiOperation(value="查询增减员计划子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemQuery", dataType = "EmpSocPlanItemQuery", value = "增减员计划子项表查询参数", paramType = "query")
    })
    Result<List<EmpSocPlanItemListVO>> listAll(EmpSocPlanItemQuery empSocPlanItemQuery);


     /**
     * 分页查询增减员计划子项表
     * @param empSocPlanItemQuery 增减员计划子项表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询增减员计划子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empSocPlanItemQuery", dataType = "EmpSocPlanItemQuery", value = "增减员计划子项表查询参数", paramType = "query")
    })
    Result<Page<EmpSocPlanItemListVO>> page(EmpSocPlanItemQuery empSocPlanItemQuery);


}

